Техники за рефакторинг на Python: Изчерпателно ръководство за подобрение на качеството на кода

В непрекъснато развиващия се пейзаж на разработката на софтуер, поддържането на чист, ефективен и разбираем код е от първостепенно значение. Python, известен със своята четимост, все още може да стане жертва на лоши практики в кода и технически дълг, ако не се управлява внимателно. Рефакторингът е процесът на преструктуриране на съществуващ компютърен код - промяна на факторизацията - без да се променя външното му поведение. По същество, това е почистване на вашия код, без да го счупите. Това ръководство изследва различни техники за рефакторинг на Python, предоставяйки практически примери и най-добри практики за повишаване на качеството на вашия код.

Защо да рефакторираме Python код?

Рефакторингът предлага многобройни ползи, включително:

• Подобрена четимост: Прави кода по-лесен за разбиране и поддръжка.
• Намалена сложност: Опростява сложната логика, намалявайки вероятността от грешки.
• Подобрена поддръжка: Улеснява по-лесната модификация и разширяване на кода.
• Увеличена производителност: Може да оптимизира кода за по-добра скорост на изпълнение.
• По-нисък технически дълг: Предотвратява натрупването на код, който е труден за поддръжка или разширяване.
• По-добър дизайн: Води до по-стабилна и гъвкава кодова архитектура.

Игнорирането на рефакторинга може да доведе до код, който е труден за разбиране, модифициране и тестване. Това може значително да увеличи времето за разработка и риска от въвеждане на грешки.

Кога да рефакторираме?

Да знаете кога да рефакторирате е от решаващо значение. Ето някои общи сценарии:

• Преди добавяне на нови функции: Рефакторирането на съществуващия код може да улесни интегрирането на нова функционалност.
• След отстраняване на грешка: Рефакторирането на околния код може да предотврати повторната поява на подобни грешки.
• По време на код ревюта: Идентифицирайте области, които могат да бъдат подобрени, и ги рефакторирайте.
• Когато срещнете "Лоши практики в кода": Лошите практики в кода са индикатори за потенциални проблеми във вашия код.
• Редовно планиран рефакторинг: Включете рефакторинга в процеса си на разработка като редовна дейност.

Идентифициране на лоши практики в кода

Лошите практики в кода са повърхностни индикации, които обикновено съответстват на по-дълбок проблем в системата. Те не винаги показват проблем, но често изискват допълнително разследване.

Общи лоши практики в Python код:

• Дублиран код: Идентичен или много подобен код, появяващ се на няколко места.
• Дълъг метод/функция: Методи или функции, които са прекалено дълги и сложни.
• Голям клас: Класове, които имат твърде много отговорности.
• Дълъг списък с параметри: Методи или функции с твърде много параметри.
• Групи от данни: Групи от данни, които често се появяват заедно.
• Примитивна обсесия: Използване на примитивни типове данни вместо създаване на обекти.
• Switch оператори: Дълги вериги от if/elif/else оператори или switch оператори.
• Хирургия с пушка: Извършването на една промяна изисква извършването на много малки промени в различни класове.
• Разминаваща се промяна: Един клас обикновено се променя по различни начини по различни причини.
• Завист за функция: Методът има достъп до данните на друг обект повече от собствените си данни.
• Вериги от съобщения: Клиентът иска един обект да поиска друг обект да поиска друг обект...

Техники за рефакторинг на Python: Практическо ръководство

Този раздел описва няколко общи техники за рефакторинг на Python с практически примери.

1. Извличане на метод/функция

Тази техника включва вземане на блок от код в рамките на метод или функция и преместването му в нов, отделен метод или функция. Това намалява сложността на оригиналния метод и прави извлечения код за многократна употреба.

Пример:

            
def print_invoice(customer, details):
    print("***********************")
    print(f"Customer: {customer}")
    print("***********************")

    total_amount = 0
    for order in details["orders"]:
        total_amount += order["amount"]

    print(f"Amount is : {total_amount}")

    if total_amount > 1000:
        print("You earned a discount!")

            

              
                Copy
              
            
          

Рефакторирано:

            
def print_header(customer):
    print("***********************")
    print(f"Customer: {customer}")
    print("***********************")


def calculate_total(details):
    total_amount = 0
    for order in details["orders"]:
        total_amount += order["amount"]
    return total_amount


def print_invoice(customer, details):
    print_header(customer)
    total_amount = calculate_total(details)
    print(f"Amount is : {total_amount}")

    if total_amount > 1000:
        print("You earned a discount!")

            

              
                Copy
              
            
          

2. Извличане на клас

Когато един клас има твърде много отговорности, извлечете някои от тях в нов клас. Това насърчава принципа за единствена отговорност.

Пример:

            
class Person:
    def __init__(self, name, phone_number, office_area_code, office_number):
        self.name = name
        self.phone_number = phone_number
        self.office_area_code = office_area_code
        self.office_number = office_number

    def get_name(self):
        return self.name

    def get_phone_number(self):
        return f"({self.office_area_code}) {self.office_number}"

            

              
                Copy
              
            
          

Рефакторирано:

            
class PhoneNumber:
    def __init__(self, area_code, number):
        self.area_code = area_code
        self.number = number

    def get_phone_number(self):
        return f"({self.area_code}) {self.number}"


class Person:
    def __init__(self, name, phone_number):
        self.name = name
        self.phone_number = phone_number

    def get_name(self):
        return self.name


            

              
                Copy
              
            
          

3. Вграждане на метод/функция

Това е обратното на извличане на метод. Ако тялото на метода е толкова ясно, колкото името му, можете да вградите метода, като замените извикванията към метода със съдържанието на метода.

Пример:

            
def get_rating(driver):
    return more_than_five_late_deliveries(driver) ? 2 : 1


def more_than_five_late_deliveries(driver):
    return driver.number_of_late_deliveries > 5

            

              
                Copy
              
            
          

Рефакторирано:

            
def get_rating(driver):
    return driver.number_of_late_deliveries > 5 ? 2 : 1

            

              
                Copy
              
            
          

4. Замяна на временна променлива с заявка

Вместо да използвате временна променлива за съхраняване на резултата от израз, извлечете израза в метод. Това избягва дублирането на код и насърчава по-добра четимост.

Пример:

            
def get_price(order):
    base_price = order.quantity * order.item_price
    discount_factor = 0.98 if base_price > 1000 else 0.95
    return base_price * discount_factor

            

              
                Copy
              
            
          

Рефакторирано:

            
def get_price(order):
    return base_price(order) * discount_factor(order)


def base_price(order):
    return order.quantity * order.item_price


def discount_factor(order):
    return 0.98 if base_price(order) > 1000 else 0.95

            

              
                Copy
              
            
          

5. Въвеждане на обект с параметри

Ако имате дълъг списък с параметри, които често се появяват заедно, помислете за създаване на обект с параметри, за да ги капсулирате. Това намалява дължината на списъка с параметри и подобрява организацията на кода.

Пример:

            
def calculate_total(width, height, depth, weight, shipping_method):
    # Calculation logic
    pass

            

              
                Copy
              
            
          

Рефакторирано:

            
class ShippingDetails:
    def __init__(self, width, height, depth, weight, shipping_method):
        self.width = width
        self.height = height
        self.depth = depth
        self.weight = weight
        self.shipping_method = shipping_method


def calculate_total(shipping_details):
    # Calculation logic using shipping_details attributes
    pass

            

              
                Copy